<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<title>Docs For Class Missus</title>
			<link rel="stylesheet" href="stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Missus</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">author:</span> Denis Hovart &lt;<a href="mailto:dhovart@gmail.com">dhovart@gmail.com</a>&gt;</li>
				<li><span class="field">version:</span> 0.1</li>
				<li><span class="field">license:</span> www.gnu.org/copyleft/lesser.html</li>
			</ul>
		
				
		<pre></pre>
	
			</div>
</div>


    <div id="summary-container">
    	<a name="sec-var-summary"></a>
    	<div class="info-box var-box">
    		<div class="info-box-title">Variable Summary</span></div>
    		<div class="nav-bar">
    			<a href="#sec-description">Description</a> |
    						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
    							| 
    									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
    								</div>
    		<div class="info-box-body">
    			<div class="var-summary">
    																																																																																																																																																																								<div class="var-title">
    					<span class="var-type">boolean</span>
    					<a href="#$authenticated" title="details" class="var-name">$authenticated</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$bare_jid" title="details" class="var-name">$bare_jid</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$domain" title="details" class="var-name">$domain</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">array</span>
    					<a href="#$events" title="details" class="var-name">$events</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$full_jid" title="details" class="var-name">$full_jid</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$host" title="details" class="var-name">$host</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">Integer</span>
    					<a href="#$id" title="details" class="var-name">$id</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">boolean</span>
    					<a href="#$id_is_set" title="details" class="var-name">$id_is_set</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">boolean</span>
    					<a href="#$is_bot" title="details" class="var-name">$is_bot</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$jid" title="details" class="var-name">$jid</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$password" title="details" class="var-name">$password</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">Integer</span>
    					<a href="#$port" title="details" class="var-name">$port</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$received" title="details" class="var-name">$received</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">array</span>
    					<a href="#$roster" title="details" class="var-name">$roster</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">boolean</span>
    					<a href="#$timeout" title="details" class="var-name">$timeout</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">boolean</span>
    					<a href="#$tls_is_set" title="details" class="var-name">$tls_is_set</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">string</span>
    					<a href="#$username" title="details" class="var-name">$username</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">boolean</span>
    					<a href="#$use_bosh" title="details" class="var-name">$use_bosh</a>
    				</div>
    																<div class="var-title">
    					<span class="var-type">boolean</span>
    					<a href="#$use_tls" title="details" class="var-name">$use_tls</a>
    				</div>
    											</div>
    		</div>
    	</div>

    	<a name="sec-method-summary"></a>
    	<div class="info-box method-box">
    		<div class="info-box-title">Method Summary</span></div>
    		<div class="nav-bar">
    			<a href="#sec-description">Description</a> |
    																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
    				|
    						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    		</div>
    		<div class="info-box-body">			
    			<div class="method-summary">
																																																																																																																																																																																																																				
    												<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#__construct" title="details" class="method-name">__construct</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$host</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$use_tls</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$use_bosh</span> = <span class="var-default">false</span>], [<span class="var-type">Integer</span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">5222</span>])
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#addEventListener" title="details" class="method-name">addEventListener</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$eventName</span>)
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#connect" title="details" class="method-name">connect</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#disconnect" title="details" class="method-name">disconnect</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#emptyReceivedContent" title="details" class="method-name">emptyReceivedContent</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">array</span>
    										<a href="#getRoster" title="details" class="method-name">getRoster</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#initiateXMLStream" title="details" class="method-name">initiateXMLStream</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#listen" title="details" class="method-name">listen</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object|false</span>
    										<a href="#load_xml_string" title="details" class="method-name">load_xml_string</a>
    											(<span class="var-type"></span>&nbsp;<span class="var-name">$string</span>)
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#logEvents" title="details" class="method-name">logEvents</a>
    											([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$html</span> = <span class="var-default">false</span>])
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#message" title="details" class="method-name">message</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$body</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$thread</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$payload</span> = <span class="var-default">null</span>])
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#messageHTML" title="details" class="method-name">messageHTML</a>
    											(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$contents</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$thread</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#onConnect" title="details" class="method-name">onConnect</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#onReceivedContent" title="details" class="method-name">onReceivedContent</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#readFromStream" title="details" class="method-name">readFromStream</a>
    											([<span class="var-type">integer</span>&nbsp;<span class="var-name">$buffer</span> = <span class="var-default">8192</span>])
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#removeEventListener" title="details" class="method-name">removeEventListener</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#setAvailability" title="details" class="method-name">setAvailability</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$availability</span>)
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#setLang" title="details" class="method-name">setLang</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$lang</span>)
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#setPersistent" title="details" class="method-name">setPersistent</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#setPresence" title="details" class="method-name">setPresence</a>
    											([<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#setPriority" title="details" class="method-name">setPriority</a>
    											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$priority</span>)
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#setStatus" title="details" class="method-name">setStatus</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$status</span>)
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#showPresence" title="details" class="method-name">showPresence</a>
    										()
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#subscribe" title="details" class="method-name">subscribe</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>)
    									</div>
    																<div class="method-definition">
    											<span class="method-result">object</span>
    										<a href="#subscribeBack" title="details" class="method-name">subscribeBack</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$status</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$group</span> = <span class="var-default">null</span>])
    									</div>
    																<div class="method-definition">
    											<span class="method-result">void</span>
    										<a href="#writeToStream" title="details" class="method-name">writeToStream</a>
    											(<span class="var-type">string</span>&nbsp;<span class="var-name">$contents</span>)
    									</div>
    								</div>
    		</div>
    	</div>		
    </div>

    <div id="content-container">
	<a name="sec-vars"></a>
	<div class="info-box content">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$authenticated" id="$authenticated"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$authenticated</span>
						(line <span class="line-number">113</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$bare_jid" id="$bare_jid"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$bare_jid</span>
						(line <span class="line-number">85</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$domain" id="$domain"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$domain</span>
						(line <span class="line-number">77</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$events" id="$events"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$events</span>
						(line <span class="line-number">109</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$full_jid" id="$full_jid"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$full_jid</span>
						(line <span class="line-number">89</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$host" id="$host"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$host</span>
						(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$id" id="$id"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">Integer</span>
			<span class="var-name">$id</span>
						(line <span class="line-number">97</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$id_is_set" id="$id_is_set"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$id_is_set</span>
						(line <span class="line-number">121</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$is_bot" id="$is_bot"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$is_bot</span>
						(line <span class="line-number">133</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$jid" id="$jid"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$jid</span>
						(line <span class="line-number">93</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$password" id="$password"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$password</span>
						(line <span class="line-number">81</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">Integer</span>
			<span class="var-name">$port</span>
						(line <span class="line-number">69</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$received" id="$received"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$received</span>
						(line <span class="line-number">129</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$roster" id="$roster"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$roster</span>
						(line <span class="line-number">101</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$timeout" id="$timeout"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$timeout</span>
						(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$tls_is_set" id="$tls_is_set"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$tls_is_set</span>
						(line <span class="line-number">117</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$username" id="$username"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$username</span>
						(line <span class="line-number">73</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$use_bosh" id="$use_bosh"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$use_bosh</span>
						(line <span class="line-number">52</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$use_tls" id="$use_tls"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$use_tls</span>
						(line <span class="line-number">48</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box content">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">149</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$host</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$use_tls</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$use_bosh</span> = <span class="var-default">false</span>], [<span class="var-type">Integer</span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">5222</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$domain</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$host</span><span class="var-description">: If null, same as $domain</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$use_tls</span><span class="var-description">: If set to true, will attempt a secured encypted connection over TLS (if proposed by server)</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$use_bosh</span><span class="var-description">: (Not yet implemented)</span>			</li>
					<li>
				<span class="var-type">Integer</span>
				<span class="var-name">$port</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddEventListener" id="addEventListener"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">addEventListener</span> (line <span class="line-number">412</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a &quot;listener&quot;, that will call a custom-defined function that checks if an event occured.</p>
<p class="description"><p>You can then trigger whatever function you want as a callback in the function you just defined.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			addEventListener
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$eventName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$eventName</span><span class="var-description">: The name of the event and of the function (must be of protected access) that you want to call</span>			</li>
				</ul>
		
			
	</div>
<a name="methodconnect" id="connect"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">connect</span> (line <span class="line-number">223</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Open a new stream to the specified host on the specified port, then attempt authentication</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			connect
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoddisconnect" id="disconnect"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">disconnect</span> (line <span class="line-number">240</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Close XML stream and shut down socket</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			disconnect
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodemptyReceivedContent" id="emptyReceivedContent"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">emptyReceivedContent</span> (line <span class="line-number">467</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clean buffer</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			emptyReceivedContent
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetRoster" id="getRoster"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getRoster</span> (line <span class="line-number">348</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns user roster</p>
	<ul class="tags">
				<li><span class="field">return:</span> array( array( 'name' =&gt; 'Username', 'jid' =&gt; 'foo@bar', 'subscription' =&gt; 'both' ), array(...) )</li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#rfc.section.5.5">http://xmpp.org/rfcs/rfc3921.html#rfc.section.5.5</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">array</span>
		<span class="method-name">
			getRoster
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodinitiateXMLStream" id="initiateXMLStream"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">initiateXMLStream</span> (line <span class="line-number">479</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends a new XML stream to server</p>
	<ul class="tags">
				<li><span class="field">link:</span> <a href="http://tools.ietf.org/html/rfc3920#section-4">http://tools.ietf.org/html/rfc3920#section-4</a></li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			initiateXMLStream
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlisten" id="listen"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">listen</span> (line <span class="line-number">429</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Execute the first function in top of the events stack</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			listen
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodload_xml_string" id="load_xml_string"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">load_xml_string</span> (line <span class="line-number">398</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads an xml string and turns it into a SimpleXMLElement object</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object|false</span>
		<span class="method-name">
			load_xml_string
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$string</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$string</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlogEvents" id="logEvents"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">logEvents</span> (line <span class="line-number">195</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Activate events log</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			logEvents
		</span>
					([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$html</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$html</span><span class="var-description">: convert special chars in log content to html entities</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmessage" id="message"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">message</span> (line <span class="line-number">362</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send a message to a user</p>
	<ul class="tags">
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#rfc.section.2.1">http://xmpp.org/rfcs/rfc3921.html#rfc.section.2.1</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="index.html#methodmessageHTML">Missus::messageHTML()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			message
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$body</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$thread</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$payload</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$to</span><span class="var-description">: The jid of the user you wish to send a message to</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$body</span><span class="var-description">: The content of your message</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$subject</span><span class="var-description">: If any, the subject of the message</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$thread</span><span class="var-description">: If any, the thread the message belongs to</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$type</span><span class="var-description">: The type of message. If null, set as 'chat'</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$payload</span><span class="var-description">: Eventual XML payload</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmessageHTML" id="messageHTML"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">messageHTML</span> (line <span class="line-number">382</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send an HTML message to a user</p>
	<ul class="tags">
				<li><span class="field">link:</span> <a href="http://xmpp.org/extensions/xep-0071.html">http://xmpp.org/extensions/xep-0071.html</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="index.html#methodmessage">Missus::message()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			messageHTML
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$contents</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$thread</span> = <span class="var-default">null</span>], [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$contents</span><span class="var-description">: The content of your message</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$subject</span><span class="var-description">: If any, the subject of the message</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$thread</span><span class="var-description">: If any, the thread the message belongs to</span>			</li>
					<li>
				<span class="var-type">string|null</span>
				<span class="var-name">$type</span><span class="var-description">: The type of message. If null, set as 'chat'</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$to</span>			</li>
				</ul>
		
			
	</div>
<a name="methodonConnect" id="onConnect"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">onConnect</span> (line <span class="line-number">183</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Those has to be overriden if you wish to create a bot over a persistent connection</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			onConnect
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodonReceivedContent" id="onReceivedContent"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">onReceivedContent</span> (line <span class="line-number">184</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			onReceivedContent
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodreadFromStream" id="readFromStream"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">readFromStream</span> (line <span class="line-number">451</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Read from the stream</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			readFromStream
		</span>
					([<span class="var-type">integer</span>&nbsp;<span class="var-name">$buffer</span> = <span class="var-default">8192</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$buffer</span><span class="var-description">: The length of the max amount of bytes you want to read from the stream</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveEventListener" id="removeEventListener"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">removeEventListener</span> (line <span class="line-number">421</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove last event</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			removeEventListener
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetAvailability" id="setAvailability"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setAvailability</span> (line <span class="line-number">266</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set user availibility</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#stanzas-presence-children-show">http://xmpp.org/rfcs/rfc3921.html#stanzas-presence-children-show</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="index.html#methodsetPresence">Missus::setPresence()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			setAvailability
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$availability</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$availability</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetLang" id="setLang"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setLang</span> (line <span class="line-number">206</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">link:</span> <a href="http://www.w3.org/TR/xml/#sec-lang-tag">http://www.w3.org/TR/xml/#sec-lang-tag</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			setLang
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$lang</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$lang</span><span class="var-description">: The lang you wish to set your content to</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetPersistent" id="setPersistent"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setPersistent</span> (line <span class="line-number">215</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the connection as persistent</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			setPersistent
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetPresence" id="setPresence"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setPresence</span> (line <span class="line-number">330</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Defines user presence</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#rfc.section.5.5">http://xmpp.org/rfcs/rfc3921.html#rfc.section.5.5</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="index.html#methodsubscribe">Missus::subscribe()</a></li>
				<li><span class="field">usedby:</span> <a href="index.html#methodsubscribeBack">Missus::subscribeBack()</a></li>
				<li><span class="field">usedby:</span> <a href="index.html#methodsetPriority">Missus::setPriority()</a></li>
				<li><span class="field">usedby:</span> <a href="index.html#methodsetAvailability">Missus::setAvailability()</a></li>
				<li><span class="field">usedby:</span> <a href="index.html#methodshowPresence">Missus::showPresence()</a></li>
				<li><span class="field">usedby:</span> <a href="index.html#methodsetStatus">Missus::setStatus()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			setPresence
		</span>
					([<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: An associative array that coutains one or several of the following options : subscribe, subscribed, status, show, priority</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetPriority" id="setPriority"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setPriority</span> (line <span class="line-number">290</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set user priority</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#stanzas-presence-children-priority">http://xmpp.org/rfcs/rfc3921.html#stanzas-presence-children-priority</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="index.html#methodsetPresence">Missus::setPresence()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			setPriority
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$priority</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$priority</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetStatus" id="setStatus"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setStatus</span> (line <span class="line-number">278</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set user status</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#stanzas-presence-children-status">http://xmpp.org/rfcs/rfc3921.html#stanzas-presence-children-status</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="index.html#methodsetPresence">Missus::setPresence()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			setStatus
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$status</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$status</span>			</li>
				</ul>
		
			
	</div>
<a name="methodshowPresence" id="showPresence"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">showPresence</span> (line <span class="line-number">254</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show user presence</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="index.html#methodsetPresence">Missus::setPresence()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			showPresence
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsubscribe" id="subscribe"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">subscribe</span> (line <span class="line-number">302</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send a subscription request to a user</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#rfc.section.6.1">http://xmpp.org/rfcs/rfc3921.html#rfc.section.6.1</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="index.html#methodsetPresence">Missus::setPresence()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			subscribe
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$to</span><span class="var-description">: the jid of the user you wish to subscribe to</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsubscribeBack" id="subscribeBack"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">subscribeBack</span> (line <span class="line-number">317</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Subscribe back to a user</p>
	<ul class="tags">
				<li><span class="field">return:</span> Instance of the class</li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#rfc.section.6.2">http://xmpp.org/rfcs/rfc3921.html#rfc.section.6.2</a></li>
				<li><span class="field">link:</span> <a href="http://xmpp.org/rfcs/rfc3921.html#rfc.section.8.3">http://xmpp.org/rfcs/rfc3921.html#rfc.section.8.3</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="index.html#methodsetPresence">Missus::setPresence()</a></li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">object</span>
		<span class="method-name">
			subscribeBack
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$status</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$group</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$to</span><span class="var-description">: the jid of the user you wish to subscribe back to</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$group</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$status</span>			</li>
				</ul>
		
			
	</div>
<a name="methodwriteToStream" id="writeToStream"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">writeToStream</span> (line <span class="line-number">442</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Write to the stream</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature"><h3>Use:</h3>
		<span class="method-result">void</span>
		<span class="method-name">
			writeToStream
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$contents</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$contents</span>			</li>
				</ul>
		
			
	</div>
    </div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Thu, 25 Feb 2010 22:14:30 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>